Skip to main content

Add product

POST 
/baskets/:id/products/:productId

Adds the specified product to the basket. Most products in OneBasket are generally able to be added to a basket with this endpoint. For specific types of products, such as ticketed events, see the select seats endpoint.

Request​

Path Parameters

    id stringrequired

    The id of the basket

    productId stringrequired

    The product id of the ticketed event that tickets are being purchased for.

Header Parameters

    x-api-key stringrequired

    The API key for the given store

Body

required

Fields to refine the context of the product being added to the basket

    quantity int32required

    The number of instances of the product to add te the basket

    productGroupId string

    The product that the product belongs to, if applicable

    kioskId string

    The kiosk that the product belongs to, if applicable

    timestreamId string

    The time stream that the product belongs to, if applicable

Responses​

This is an asynchronous operation. Upon completion, the basket must be refetched.

Schema
    notificationId stringrequired

    The id of a notification that represents this asynchronous request. OneBasket will be processing the request in the background, and upon completion this notification will be updated with the result.

Loading...